Skip to main content

Documentation

The Documentation component provides an interactive interface for viewing and understanding your data layer implementation. It displays all configured events, their parameters, and example implementations.

Overview​

The Documentation interface consists of two main views:

  1. Tracking Overview: A table view of all configured events
  2. Event Detail: Detailed information about a specific event

Features​

Tracking Overview​

The overview page displays a comprehensive table of all configured events:

Table Columns​

  • Event Name: The name of the event
  • Description: A brief description of what the event represents
  • Parameters: A comma-separated list of parameters associated with the event
  • Click on any event row to view its detailed information
  • Events are sorted alphabetically by name
  • Active event is highlighted in the table

Event Detail View​

When you select an event, you'll see detailed information about that specific event:

Event Information​

  • Event Name: The name of the selected event
  • Description: Detailed description of the event's purpose
  • Back Button: Returns to the overview page

Parameters Table​

A detailed table showing all parameters associated with the event:

Table Columns​
  • Parameter Name: The name of the parameter
  • Description: Parameter description
  • Data Type: The expected data type
  • Required: Whether the parameter is required
  • Allowed Values: List of allowed values (if any)
  • Example Values: Example values for the parameter

Example Implementation​

  • Code Block: Shows a complete example of how to implement the event
  • Format: Properly formatted JavaScript code
  • Structure: Follows data layer best practices

Example Implementation​

The component generates example implementations based on the following rules:

Parameter Value Generation​

  1. Example Values: Uses the first example value if available
  2. Allowed Values: Uses the first allowed value if no example value exists
  3. Default Values: Generates appropriate default values based on data type:
    • String: "example_[parameter_name]"
    • Number: 123
    • Boolean: true
    • Object: {}
    • Array: []

Data Layer Structure​

  • Event Name: Added as the event property
  • Parameters: Properly nested based on parameter names
  • Formatting: Proper indentation and JSON structure

Usage​

Viewing Events​

  1. Navigate to the Documentation page
  2. Browse the list of events in the overview table
  3. Click on an event to view its details

Understanding Parameters​

  1. Select an event to view its parameters
  2. Review the parameter table for detailed information
  3. Check the example implementation for usage guidance

Implementation Guide​

  1. Review the event's parameters and requirements
  2. Use the example implementation as a template
  3. Customize the values according to your needs

Best Practices​

Event Documentation​

  1. Clear Names: Use descriptive event names
  2. Detailed Descriptions: Explain the event's purpose
  3. Complete Parameter List: Include all required parameters

Parameter Documentation​

  1. Accurate Types: Specify correct data types
  2. Required Fields: Mark required parameters
  3. Example Values: Provide realistic examples
  4. Allowed Values: List all valid options

Implementation​

  1. Follow Structure: Use the provided example structure
  2. Validate Data: Ensure all required parameters are included
  3. Check Types: Verify parameter data types
  4. Test Implementation: Verify the event fires correctly

Technical Notes​

Data Loading​

  • Loads configuration data on component mount
  • Handles loading and error states
  • Caches data for better performance

Parameter Filtering​

  • Filters parameters by associated event
  • Maintains parameter relationships
  • Handles missing or invalid data

Example Generation​

  • Dynamically generates examples
  • Handles nested parameter structures
  • Formats code for readability

Error Handling​

Loading States​

  • Shows loading indicator while fetching data
  • Handles failed data fetches gracefully
  • Provides clear error messages

Data Validation​

  • Validates configuration data
  • Handles missing or invalid parameters
  • Provides fallback values when needed

Troubleshooting​

Common Issues​

  1. Missing Parameters:

    • Check parameter configuration
    • Verify event associations
    • Review required fields

  2. Incorrect Data Types:

    • Verify parameter types
    • Check example values
    • Review allowed values

  3. Implementation Errors:

    • Follow example structure
    • Check parameter names
    • Verify data types

Getting Help​

  • Review the documentation
  • Check parameter configurations
  • Contact support if needed